/*
 * Copyright (c) 2011-2012 Alexander Dubu
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * o  Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 *
 * o  Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *
 * o  Neither the name Axil nor the names of its contributors may be used to
 *    endorse or promote products derived from this software without specific
 *    prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

package axil.definition;

import axil.api.AxilType;
import axil.framework.error.InternalException;
import axil.framework.validation.ValidationContext;
import axil.framework.xml.InputXML;

import static axil.framework.Functions.*;


/**
 * The XML-based definition of an Axil type. In additional to the behavioral
 * parts of type metadata defined by the AxilType object, the TypeDefinition
 * provides the documentation.
 */
public class TypeDefinition extends DefinitionWithExample {
	private Units units;

	private transient AxilType type;


	public TypeDefinition(InputXML xml) {
		super(xml);
		units = xml.object(Units.class, "unitized", null);
		if (units != null) {
			units.link(this);
		}
	}


	public boolean extended()		{
		return units != null;
	}
	public UnitDefinition base()	{
		return units.baseline();
	}


	/**
	 * Return the label by which this object identifies itself. The string
	 * returned cannot be null or empty.
	 */
	public String label() {
		return "type";
	}


	public AxilType type() {
		if (type == null) {
			try {
				type = declaration(classof(code().classname()), AxilType.class,
				                   "type");
				if (type == null) {
					type = construct(AxilType.class, code().classname());
				}
			} catch (InternalException ex) {
				throw abort(ex,
				            "Cannot load class representing the Axil type metadata. " +
				            "The type class must either provide a static member named " +
				            "'type' that contains the type metadata or provide a " +
				            "parameter-less, public constructor.",
				            nv("type", identity()),
				            nv("class-name", code().classname()));
			}
		}
		return type;
	}


	/**
	 * Validate this object in the given context. Any problems detected with the
	 * correctness or completeness of this object are placed into the context.
	 * This method descends into its owned members, validating them as well.
	 */
	public void validate(ValidationContext context) {
		super.validate(context);
		context.validate("units", units, true);
		type();
	}
}
